/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the HISP project nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.dashboard;

import java.util.List;
import java.util.Set;
import org.hisp.dhis.document.Document;
import org.hisp.dhis.eventchart.EventChart;
import org.hisp.dhis.eventreport.EventReport;
import org.hisp.dhis.eventvisualization.EventVisualization;
import org.hisp.dhis.mapping.Map;
import org.hisp.dhis.report.Report;
import org.hisp.dhis.user.User;
import org.hisp.dhis.visualization.Visualization;

/**
 * @author Lars Helge Overland
 */
public interface DashboardService {
  String ID = DashboardService.class.getName();

  // -------------------------------------------------------------------------
  // Dashboard
  // -------------------------------------------------------------------------

  DashboardSearchResult search(String query);

  DashboardSearchResult search(
      String query, Set<DashboardItemType> maxTypes, Integer count, Integer maxCount);

  DashboardSearchResult search(String query, Set<DashboardItemType> maxTypes);

  DashboardSearchResult search(Set<DashboardItemType> maxTypes, Integer count, Integer maxCount);

  DashboardSearchResult search(Set<DashboardItemType> maxTypes);

  DashboardItem addItemContent(String dashboardUid, DashboardItemType type, String contentUid);

  void mergeDashboard(Dashboard dashboard);

  void mergeDashboardItem(DashboardItem item);

  long saveDashboard(Dashboard dashboard);

  void updateDashboard(Dashboard dashboard);

  void deleteDashboard(Dashboard dashboard);

  Dashboard getDashboard(long id);

  Dashboard getDashboard(String uid);

  // -------------------------------------------------------------------------
  // DashboardItem
  // -------------------------------------------------------------------------

  void updateDashboardItem(DashboardItem item);

  DashboardItem getDashboardItem(String uid);

  Dashboard getDashboardFromDashboardItem(DashboardItem dashboardItem);

  void deleteDashboardItem(DashboardItem item);

  List<DashboardItem> getVisualizationDashboardItems(Visualization visualization);

  List<DashboardItem> getEventVisualizationDashboardItems(EventVisualization eventVisualization);

  List<DashboardItem> getEventChartDashboardItems(EventChart eventChart);

  List<DashboardItem> getMapDashboardItems(Map map);

  List<DashboardItem> getEventReportDashboardItems(EventReport eventReport);

  List<DashboardItem> getUserDashboardItems(User user);

  List<DashboardItem> getReportDashboardItems(Report report);

  List<DashboardItem> getDocumentDashboardItems(Document document);
}
